/*
 * Copyright 2012-2021 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.context.config;

import java.util.Collections;
import java.util.List;

import org.apache.commons.logging.Log;

import org.springframework.boot.BootstrapContext;
import org.springframework.boot.BootstrapRegistry;
import org.springframework.boot.ConfigurableBootstrapContext;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.boot.logging.DeferredLogFactory;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.core.env.Environment;
import org.springframework.core.io.ResourceLoader;

/**
 * 用于将 {@link ConfigDataLocation 位置} 解析成一个或多个 {@link ConfigDataResource 资源} 的策略接口。
 * 实现类应作为 {@code spring.factories} 条目添加。支持以下构造函数参数类型：
 * <ul>
 * <li>{@link Log} 或 {@link DeferredLogFactory} - 如果解析器需要延迟日志记录</li>
 * <li>{@link Binder} - 如果解析器需要从初始 {@link Environment} 中获取值</li>
 * <li>{@link ResourceLoader} - 如果解析器需要资源加载器</li>
 * <li>{@link ConfigurableBootstrapContext} - 可用于存储可能开销较大或需要共享的对象的启动上下文
 * （也可以使用 {@link BootstrapContext} 或 {@link BootstrapRegistry}）。</li>
 * </ul>
 * <p>
 * 解析器可以实现 {@link Ordered} 接口或使用 {@link Order @Order} 注解。
 * 支持指定位置的第一个解析器将被使用。
 *
 * @param <R> 位置资源类型
 * @author Phillip Webb
 * @author Madhura Bhave
 * @since 2.4.0
 */
public interface ConfigDataLocationResolver<R extends ConfigDataResource> {

	/**
	 * 判断指定的位置地址是否可以被此解析器处理。
	 * @param context 位置解析器上下文
	 * @param location 待检查的位置
	 * @return 该位置是否被此解析器支持
	 */
	boolean isResolvable(ConfigDataLocationResolverContext context, ConfigDataLocation location);

	/**
	 * 将 {@link ConfigDataLocation} 解析为一个或多个 {@link ConfigDataResource} 实例。
	 * @param context 位置解析器上下文
	 * @param location 需要解析的位置
	 * @return 按优先级升序排列的 {@link ConfigDataResource} 列表
	 * @throws ConfigDataLocationNotFoundException 如果是非可选位置且未找到，则抛出异常
	 * @throws ConfigDataResourceNotFoundException 如果解析出的资源未找到，则抛出异常
	 */
	List<R> resolve(ConfigDataLocationResolverContext context, ConfigDataLocation location)
			throws ConfigDataLocationNotFoundException, ConfigDataResourceNotFoundException;

	/**
	 * 根据可用的 profiles，将 {@link ConfigDataLocation} 解析为一个或多个 {@link ConfigDataResource} 实例。
	 * 当从贡献的值中推断出 profiles 后，会调用此方法。默认返回空列表。
	 * @param context 位置解析器上下文
	 * @param location 需要解析的位置
	 * @param profiles profile 信息
	 * @return 按优先级升序排列的解析后位置列表
	 * @throws ConfigDataLocationNotFoundException 如果是非可选位置且未找到，则抛出异常
	 */
	default List<R> resolveProfileSpecific(ConfigDataLocationResolverContext context, ConfigDataLocation location,
			Profiles profiles) throws ConfigDataLocationNotFoundException {
		return Collections.emptyList();
	}

}
